<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSocket</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 3 参考手册">
<link rel="up" href="PlugSocket.html" title="跨进程嵌入">
<link rel="prev" href="gtk3-GtkPlug.html" title="GtkPlug">
<link rel="next" href="RecentDocuments.html" title="最近使用文档">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gtk3-GtkPlug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 3 参考手册</th>
<td><a accesskey="n" href="RecentDocuments.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk3-GtkSocket.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gtk3-GtkSocket.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gtk3-GtkSocket"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk3-GtkSocket.top_of_page"></a>GtkSocket</span></h2>
<p>GtkSocket — Container for widgets from other processes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gtk3-GtkSocket.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtkx.h&gt;

struct              <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket">GtkSocket</a>;
<a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk3-GtkSocket.html#gtk-socket-new" title="gtk_socket_new ()">gtk_socket_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gtk3-GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()">gtk_socket_add_id</a>                   (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
                                                         <em class="parameter"><code><span class="type">Window</span> window</code></em>);
<span class="returnvalue">Window</span>              <a class="link" href="gtk3-GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()">gtk_socket_get_id</a>                   (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
<a href="../gdk3/gdk3-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         <a class="link" href="gtk3-GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a>          (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gtk3-GtkSocket.description"></a><h2>Description</h2>
<p>
Together with <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a>, <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> provides the ability to embed
widgets from one process into another process in a fashion that
is transparent to the user. One process creates a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> widget
and passes that widget's window ID to the other process, which then
creates a <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> with that window ID. Any widgets contained in the
<a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> then will appear inside the first application's window.
</p>
<p>
The socket's window ID is obtained by using <a class="link" href="gtk3-GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()"><code class="function">gtk_socket_get_id()</code></a>.
Before using this function, the socket must have been realized,
and for hence, have been added to its parent.
</p>
<p>
</p>
<div class="example">
<a name="id3811782"></a><p class="title"><b>Example 87. Obtaining the window ID of a socket.</b></p>
<div class="example-contents"><pre class="programlisting">
GtkWidget *socket = gtk_socket_new ();
gtk_widget_show (socket);
gtk_container_add (GTK_CONTAINER (parent), socket);

/* The following call is only necessary if one of
 * the ancestors of the socket is not yet visible.
 */
gtk_widget_realize (socket);
g_print ("The ID of the sockets window is %x\n",
         gtk_socket_get_id (socket));
</pre></div>
</div>
<p><br class="example-break">
</p>
<p>
Note that if you pass the window ID of the socket to another
process that will create a plug in the socket, you must make
sure that the socket widget is not destroyed until that plug
is created. Violating this rule will cause unpredictable
consequences, the most likely consequence being that the plug
will appear as a separate toplevel window. You can check if
the plug has been created by using <a class="link" href="gtk3-GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()"><code class="function">gtk_socket_get_plug_window()</code></a>.
If it returns a non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value, then the plug has been
successfully created inside of the socket.
</p>
<p>
When GTK+ is notified that the embedded window has been destroyed,
then it will destroy the socket as well. You should always,
therefore, be prepared for your sockets to be destroyed at any
time when the main event loop is running. To prevent this from
happening, you can connect to the <span class="type">"plug-removed"</span> signal.
</p>
<p>
The communication between a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> and a <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> follows the
<a class="ulink" href="http://www.freedesktop.org/Standards/xembed-spec" target="_top">XEmbed</a>
protocol. This protocol has also been implemented in other toolkits,
e.g. <span class="application">Qt</span>, allowing the same level of
integration when embedding a <span class="application">Qt</span> widget
in GTK or vice versa.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
The <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> and <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> widgets are only available when GTK+
is compiled for the X11 platform and <a href="../gdk3/gdk3-General.html#GDK-WINDOWING-X11:CAPS"><code class="literal">GDK_WINDOWING_X11</code></a> is defined.
They can only be used on a <span class="type">GdkX11Display</span>. To use <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> and
<a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>, you need to include the <code class="filename">gtk/gtkx.h</code>
header.
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gtk3-GtkSocket.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSocket"></a><h3>struct GtkSocket</h3>
<pre class="programlisting">struct GtkSocket {
  GtkContainer container;

  GtkSocketPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-new"></a><h3>gtk_socket_new ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-GtkWidget.html#GtkWidget" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_socket_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new empty <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-add-id"></a><h3>gtk_socket_add_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_socket_add_id                   (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>,
                                                         <em class="parameter"><code><span class="type">Window</span> window</code></em>);</pre>
<p>
Adds an XEMBED client, such as a <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a>, to the <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>.  The
client may be in the same process or in a different process. 
</p>
<p>
To embed a <a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> in a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>, you can either create the
<a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a> with <code class="literal">gtk_plug_new (0)</code>, call 
<a class="link" href="gtk3-GtkPlug.html#gtk-plug-get-id" title="gtk_plug_get_id ()"><code class="function">gtk_plug_get_id()</code></a> to get the window ID of the plug, and then pass that to the
<a class="link" href="gtk3-GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>, or you can call <a class="link" href="gtk3-GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()"><code class="function">gtk_socket_get_id()</code></a> to get the
window ID for the socket, and call <a class="link" href="gtk3-GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a> passing in that
ID.
</p>
<p>
The <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window
 before you can make this call.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the Window of a client participating in the XEMBED protocol.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-get-id"></a><h3>gtk_socket_get_id ()</h3>
<pre class="programlisting"><span class="returnvalue">Window</span>              gtk_socket_get_id                   (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
<p>
Gets the window ID of a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> widget, which can then
be used to create a client embedded inside the socket, for
instance with <a class="link" href="gtk3-GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a>. 
</p>
<p>
The <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window 
before you can make this call.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the window ID for the socket</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3>
<pre class="programlisting"><a href="../gdk3/gdk3-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         gtk_socket_get_plug_window          (<em class="parameter"><code><a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre>
<p>
Retrieves the window of the plug. Use this to check if the plug has
been created inside of the socket.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td>
<td>a <a class="link" href="gtk3-GtkSocket.html#GtkSocket" title="struct GtkSocket"><span class="type">GtkSocket</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the window of the plug if available, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="gtk3-GtkSocket.see-also"></a><h2>See Also</h2>
<a class="link" href="gtk3-GtkPlug.html#GtkPlug" title="struct GtkPlug"><span class="type">GtkPlug</span></a>, <a class="ulink" href="http://www.freedesktop.org/Standards/xembed-spec" target="_top">XEmbed</a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>